Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: replaced the link in the documentation #1970

Closed

Conversation

braveocheretovych
Copy link
Contributor

In my opinion, the new link fits here better.

Copy link
Contributor

github-actions bot commented Apr 1, 2025

Test Results

   545 files  +  6     545 suites  +6   28m 27s ⏱️ + 3m 21s
 4 369 tests + 39   4 357 ✅ + 37   12 💤 + 2  0 ❌ ±0 
16 624 runs  +217  16 515 ✅ +206  109 💤 +11  0 ❌ ±0 

Results for commit 67fb3d1. ± Comparison against base commit f35ee7f.

♻️ This comment has been updated with latest results.

@merks
Copy link
Contributor

merks commented Apr 1, 2025

Could we hold off on this until the dust settles on this issue?

https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/issues/5805

We really need to the documentation to actually be updated when the content is modified here:

https://github.com/eclipse-platform/www.eclipse.org-swt

@braveocheretovych
Copy link
Contributor Author

I understand, tell me, should I close this request pool or keep it open?

@merks
Copy link
Contributor

merks commented Apr 2, 2025

If I understand the direction, the existing URI should work and should be redirected to something valid automatically. But we probably would be better to specify that final redirection location instead. But whether that's eclipse.dev/swt or eclipse.dev/eclipse/swt is not yet 100% clear.

If you have the patience, leaving this open as a reminder to take action is a good thing. I will add this to my pin tabs list.

@braveocheretovych
Copy link
Contributor Author

Yes, I understand you, no problem, I will wait for your answer.

@merks
Copy link
Contributor

merks commented Apr 4, 2025

@braveocheretovych

The final redirected location is the following:

https://eclipse.dev/eclipse/swt

@braveocheretovych
Copy link
Contributor Author

Done

@merks
Copy link
Contributor

merks commented Apr 4, 2025

Sorry, sorry, only now do I read the whole context. 😱

These are instructions for where to get downloads not where to get documentation. That existing page is the index. Unfortunately the documentation is rather helpful because it doesn't explain that one needs to pick a specific version, e.g.,

https://download.eclipse.org/eclipse/downloads/drops4/S-4.36M1-202504031800/

And then get an SWT zip from the list:

image

@braveocheretovych
Copy link
Contributor Author

It's okay, I completely agree with you, please check again.

@braveocheretovych
Copy link
Contributor Author

Maybe for convenience add #SWT at the end of the link, what do you think?https://download.eclipse.org/eclipse/downloads/drops4/S-4.36M1-202504031800/#SWT

@merks
Copy link
Contributor

merks commented Apr 4, 2025

The problem is that that link will be out-of-date in a few weeks and will be a broken link within 3 months. I really think the documentation must specify a location that remains valid long term.

Of course the user then ends up needing to hunt. So better to describe what is on that root download page and describe what’s on the subsequent page.

@braveocheretovych
Copy link
Contributor Author

Sorry, I'm communicating with you through a translator, there are some translation difficulties. I made a draft, check it out, did I understand everything correctly?

SWT постачається з файлами баночок, характерними для платформи. Завантажте їх із https://download.eclipse.org/eclipse/downloads/drops4/S-4.36M1-202504031800/ і додайте файл баночки до свого класного шляху.

@braveocheretovych
Copy link
Contributor Author

Hey @merks. Please help me solve this question

@merks
Copy link
Contributor

merks commented Apr 7, 2025

The summary is that I don't think can fix this just by changing the URL. You need to describe stuff in English and if that's a challenge this is probably not an appropriate task to take on...

@braveocheretovych
Copy link
Contributor Author

braveocheretovych commented Apr 8, 2025

Review my draft:

Getting Started
SWT comes with platform-specific jar files. Download the latest version of SWT from the official Eclipse SWT page or directly from the Eclipse downloads page. Add the appropriate platform-specific jar file to your classpath.

@merks
Copy link
Contributor

merks commented Apr 8, 2025

@HannesWell

I think we have a bit of a language barrier here and I'm not sure that it makes sense to contribute language-specific documentation in the face of such a language barrier...

@braveocheretovych
Copy link
Contributor Author

yes, I agree with you, I'd better close this pull request then?

@merks
Copy link
Contributor

merks commented Apr 8, 2025

I don’t know how those badges work. Maybe @HannesWell has more knowledge.

@HannesWell
Copy link
Member

HannesWell commented Apr 8, 2025

I think we have a bit of a language barrier here and I'm not sure that it makes sense to contribute language-specific documentation in the face of such a language barrier...

That makes it indeed very difficult.

But besides that, @merks is right with his statement that this link will not last long. So we should either describe verbally how to navigate to the desired section or establish some kind of latest redirection link that points to the latest. But I think the former is easier to implement.
But the current state isn't suitable.

yes, I agree with you, I'd better close this pull request then?

OK, then lets close this for now. If you are interested to implement the above suggestion, feel free to let us now so that we can reopen this or create a new PR.
Still, thank you for your effort trying to make SWT's documentation better.

@HannesWell HannesWell closed this Apr 8, 2025
@braveocheretovych
Copy link
Contributor Author

Thank you for the kind words, I'm sorry I couldn't solve this problem on my own.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants